Vcenter Vm Hardware Ethernet Info

Vcenter Vm Hardware Ethernet Info
Vcenter Vm Hardware Ethernet Info

The Vcenter Vm Hardware Ethernet Info schema contains information about a virtual Ethernet adapter.

JSON Example
{
    "label": "string",
    "type": "string",
    "upt_compatibility_enabled": false,
    "upt_v2_compatibility_enabled": false,
    "mac_type": "string",
    "mac_address": "string",
    "pci_slot_number": 0,
    "wake_on_lan_enabled": false,
    "backing": {
        "type": "string",
        "network": "string",
        "network_name": "string",
        "host_device": "string",
        "distributed_switch_uuid": "string",
        "distributed_port": "string",
        "connection_cookie": 0,
        "opaque_network_type": "string",
        "opaque_network_id": "string"
    },
    "state": "string",
    "start_connected": false,
    "allow_guest_control": false
}
string
label
Required

Device label.

string
type
Required

Ethernet adapter emulation type.

For more information see: Vcenter Vm Hardware Ethernet EmulationType.

boolean
upt_compatibility_enabled
Optional

Flag indicating whether Universal Pass-Through (UPT) compatibility is enabled on this virtual Ethernet adapter.

This property is optional and it is only relevant when the value of type is Vcenter Vm Hardware Ethernet EmulationType.VMXNE_t3.

boolean
upt_v2_compatibility_enabled
Optional

Flag indicates whether Uniform Pass-through version 2(UPTv2) compatibility is enabled on this network adapter.

This property was added in vSphere API 8.0.0.1.

This property is optional and it is only relevant when the value of type is Vcenter Vm Hardware Ethernet EmulationType.VMXNE_t3.

string
mac_type
Required

MAC address type.

For more information see: Vcenter Vm Hardware Ethernet MacAddressType.

string
mac_address
Optional

MAC address.

May be missing or null if Vcenter Vm Hardware Ethernet Info.mac_type is Vcenter Vm Hardware Ethernet MacAddressType.MANUAL and has not been specified, or if Vcenter Vm Hardware Ethernet Info.mac_type is Vcenter Vm Hardware Ethernet MacAddressType.GENERATED and the virtual machine has never been powered on since the Ethernet adapter was created.

integer As int64 As int64
pci_slot_number
Optional

Address of the virtual Ethernet adapter on the PCI bus. If the PCI address is invalid, the server will change it when the VM is started or as the device is hot added.

May be missing or null if the virtual machine has never been powered on since the adapter was created.

boolean
wake_on_lan_enabled
Required

Flag indicating whether wake-on-LAN is enabled on this virtual Ethernet adapter.

backing
Required

Physical resource backing for the virtual Ethernet adapter.

string
state
Required

Connection status of the virtual device.

For more information see: Vcenter Vm Hardware ConnectionState.

boolean
start_connected
Required

Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.

boolean
allow_guest_control
Required

Flag indicating whether the guest can connect and disconnect the device.

Returned By